Grammar Class Reference

The Grammar class. More...

Public Member Functions
String	getDescription ()
	Get grammar description. More...
	setDescription (String description)
	Set grammar description. More...
void	addStructure (Structure structure)
	Add structure. More...
void	insertStructureAtIndex (Structure structure, int index)
	Insert structure at index. More...
void	deleteStructureAtIndex (int index)
	Delete structure at index. More...
Structure	getRootNode ()
	Get root node (structure) More...
void	setStartStructure (Structure startStructure)
	Set start structure. More...
Structure	getStructureByName (String name)
	Get structure by name. More...
Structure	getStructureByIndex (int index)
	Get structure by index. More...
int	getStructureCount ()
	Get number of structures. More...
	setName (String name)
	Set grammar name. More...
String	getName ()
	get grammar name More...
	setUTI (String UTI)
	Set UTI grammar is valid for. More...
String	getUTI ()
	Get UTI grammar is valid for. More...
	setFileExtension (String fileExtension)
	Set file extension grammar is valid for. More...
String	getFileExtension ()
	Get file extension grammar is valid for. More...
	readFromFile (fileName)
	Read grammar from file. More...
	writeToFile (fileName)
	Write grammar to file. More...

Detailed Description

The Grammar class.

A grammar with all structures and their elements

Author

Andreas Pehnack

Date

2009-08-03

Member Function Documentation

addStructure()

void addStructure

(

Structure

structure

)

Add structure.

Author

Andreas Pehnack

Date

2013-04-14

Parameters

[in]

structure

The structure to be appended

See also

getRootNode()

deleteStructureAtIndex()

void deleteStructureAtIndex

(

int

index

)

Delete structure at index.

Author

Andreas Pehnack

Date

2013-04-14

Parameters

[in]

index

Index where structure should be deleted

See also

getRootNode()

getDescription()

String getDescription

(

)

Get grammar description.

Author

Andreas Pehnack

Date

2012-05-12

Returns

The description of the grammar

See also

setDescription()

getFileExtension()

String getFileExtension

(

)

Get file extension grammar is valid for.

Author

Andreas Pehnack

Date

2013-04-14

Returns

The file extension

See also

setFileExtension()

getName()

String getName

(

)

get grammar name

Author

Andreas Pehnack

Date

2010-02-21

Returns

The name of the grammar

See also

setName()

getRootNode()

Structure getRootNode

(

)

Get root node (structure)

Author

Andreas Pehnack

Date

2010-06-06

Returns

The the structure enclosing all other structures

See also

getStructureByName

getStructureByIndex()

Structure getStructureByIndex

(

int

index

)

Get structure by index.

Author

Andreas Pehnack

Date

2009-08-03

Parameters

[in]

index

Index of the structure to get

Returns

The structure you asked for or NULL if there is no structure with the name you passed

See also

getStructureByName

getStructureByName()

Structure getStructureByName

(

String

name

)

Get structure by name.

Author

Andreas Pehnack

Date

2009-08-03

Parameters

[in]

name

Name of the structure to get

Returns

The structure you asked for or NULL if there is no structure with the name you passed

See also

getStructureByID

getStructureCount()

int getStructureCount

(

)

Get number of structures.

Author

Andreas Pehnack

Date

2009-08-03

Returns

The number of structures in this grammar

See also

getStructureByIndex

getUTI()

String getUTI

(

)

Get UTI grammar is valid for.

Author

Andreas Pehnack

Date

2013-04-14

Returns

The UTI

See also

setUTI()

insertStructureAtIndex()

void insertStructureAtIndex	(	Structure	structure,
		int	index
	)

Insert structure at index.

Author

Andreas Pehnack

Date

2013-04-14

Parameters

[in]	structure	The structure to be inserted
[in]	index	Index where structure should be inserted

See also

getRootNode()

readFromFile()

readFromFile

(

fileName

)

Read grammar from file.

Author

Andreas Pehnack

Date

2015-10-14

Parameters

[in]

fileName

The grammar file

See also

writeToFile()

setDescription()

setDescription

(

String

description

)

Set grammar description.

Author

Andreas Pehnack

Date

2009-08-16

Parameters

[in]

description

The description of the grammar

See also

getDescription()

setFileExtension()

setFileExtension

(

String

fileExtension

)

Set file extension grammar is valid for.

Author

Andreas Pehnack

Date

2013-04-14

Parameters

[in]

fileExtension

The file extension to be set

See also

getFileExtension()

setName()

setName

(

String

name

)

Set grammar name.

Author

Andreas Pehnack

Date

2009-08-16

Parameters

[in]

name

The name of the grammar

See also

getName()

setStartStructure()

void setStartStructure

(

Structure

startStructure

)

Set start structure.

Author

Andreas Pehnack

Date

2010-06-06

Returns

The structure where parsing begins

See also

getRootNode

setUTI()

setUTI

(

String

UTI

)

Set UTI grammar is valid for.

Author

Andreas Pehnack

Date

2013-04-14

Parameters

[in]

UTI

The UTI

See also

getUTI()

writeToFile()

writeToFile

(

fileName

)

Write grammar to file.

Author

Andreas Pehnack

Date

2015-10-14

Parameters

[in]

fileName

The grammar file

See also

readFromFile()

---

The documentation for this class was generated from the following file:

• Generated/synalysis_wrap_lua.cpp